home *** CD-ROM | disk | FTP | other *** search
/ Aminet 3 / Aminet 3 - July 1994.iso / Aminet / util / cli / sum.lha / sum.doc < prev    next >
Encoding:
Text File  |  1994-04-03  |  4.1 KB  |  137 lines
  1.                               $VER: Sum V1.1
  2.                         Written by Oliver Kaufmann
  3.                         Released on April 3,  1994
  4.  
  5.  
  6.      This program is Freeware. Copyright 1994 by Oliver Kaufmann.
  7. All Rights Reserved.  SUM is freely distributable, but the author retains all
  8. rights in regards to the program.  Permission is granted to distribute this
  9. program for a minimal charge (for copying, handling, etc.).
  10.      Use this program at your own risk,  no warranties will be made.
  11.  
  12.  
  13.      SUM is a Shell-command which sums up numbers in formated files.
  14. SUM takes its input either from stdin or from a file or a list of files.
  15. Its output will give the sum of all numbers at the specified position in every
  16. line of the specified file(s).
  17.  
  18.  
  19. 1. INSTALLATION
  20. ---------------
  21.  
  22. Copy SUM to any directory you like that is in your path.
  23.  
  24.  
  25. I. USAGE
  26. --------
  27.  
  28. usage: sum [-h|-?] [<filepatternlist>] [-p<pos>] [-q]
  29.                 -h : show usage
  30.                 -? : show usage
  31.  <filepatternlist> : one or more files or filepatterns,
  32.                      if omitted, use stdin as input
  33.            -p<pos> : start at position <pos> in every line
  34.                 -q : quiet, do not display verbose information
  35.  
  36.  
  37. II. WHAT IS IT FOR
  38. ------------------
  39.  
  40. Suppose you've got a lot of tar archives on streamer tapes. For every archive
  41. you keep a index file which might have been produces by tar tvf tape:
  42. It will look like:
  43.  
  44. -rw------- 0/0       53 Jan 27 12:04 1994 .run.log
  45. drwx------ 0/0        0 Feb 28 19:34 1994 alt/
  46. drwx------ 0/0        0 Mar 13 20:58 1994 alt/binaries/
  47. drwx------ 0/0        0 Mar 13 20:13 1994 alt/binaries/pictures/
  48. drwx------ 0/0        0 Feb 26 20:33 1994 alt/binaries/pictures/misc/
  49. -rw------- 0/0    11319 Feb 25 22:49 1994 alt/binaries/pictures/misc/DFC06.gif
  50. -rw------- 0/0    14456 Feb 25 22:49 1994 alt/binaries/pictures/misc/DFC08.gif
  51. -rw------- 0/0    13058 Feb 25 22:49 1994 alt/binaries/pictures/misc/DFC07.gif
  52. -rw------- 0/0    45922 Feb 25 22:49 1994 alt/binaries/pictures/misc/FROG.JPG
  53. -rw------- 0/0    13290 Feb 25 22:49 1994 alt/binaries/pictures/misc/MARSAPP.JPG
  54. -rw------- 0/0    45280 Feb 25 22:49 1994 alt/binaries/pictures/misc/juliaidx.gif
  55. -rw------- 0/0    14737 Feb 25 22:50 1994 alt/binaries/pictures/misc/EINSTEIN.JPG
  56. -rw------- 0/0   195220 Feb 25 22:50 1994 alt/binaries/pictures/misc/Monet_Willows.jpg
  57. -rw------- 0/0  1348705 Feb 25 22:50 1994 alt/binaries/pictures/misc/ipal2.zip
  58.  
  59. .             ^
  60. .             |
  61. .             -- position 14
  62.                   
  63. In the case you want to restore an archive or at least a part of it,
  64. you probabliy want to know how much data is in that archive. You may do it by
  65. hand and get crazy, or you can use SUM.
  66.  
  67.  
  68. III. HOW IT WORKS
  69. -----------------
  70.  
  71. SUM takes its input, jumps to the specified position, reads the number,
  72. adds it to the sum and carries on till there are no more lines or files.
  73. Then it will print out what has been totaled up.
  74. Be aware that all arguments to switches must be directly typed after the
  75. switch, no spaces in between. If reading from stdin without redirection you
  76. finish typing by pressing CTRL-\.
  77.  
  78.  
  79. IV. EXAMPLES
  80. -------------
  81.  
  82. Type sum and enter some numbers. Then press CTRL-\.
  83.  
  84. :> sum
  85. :<- 1
  86. :<- 2
  87. :<- 'CTRL-\'
  88. :-> --------------------------------------------------------------------------
  89. :->  0 file(s) total                :         3 in      2 lines at column   0
  90.  
  91. Now you can do
  92.  
  93. :> list NOHEAD >ram:test.idx
  94. :> sum ram:test.idx -p23
  95.  
  96. :> sum i*
  97. etc.
  98.  
  99. Just play around to find out how it works.
  100.  
  101.  
  102. 2. Inspiration
  103. --------------
  104.  
  105. I use this program because I do have tar archives. I use it to calculate
  106. how much data is in the archives and how much space do I need, if I want to
  107. extract some files from an archive.
  108.  
  109.  
  110. 3. Misc
  111. -------
  112.  
  113. This program is far from complete and has not been tested too much, but it
  114. works for me.
  115.  
  116.  
  117. 4. Source
  118. ---------
  119.  
  120. I've included the source code. Everybody may use it, implement other
  121. features etc. as long as the author is mentioned.
  122.  
  123.  
  124.  
  125. 5. The Author
  126. -------------
  127.  
  128.      Oliver Kaufmann
  129.      Eserwallstrasse 8
  130.      86159 Augsburg
  131.      Germany                e-mail: kaufmano@informatik.tu-muenchen.de
  132.  
  133.  
  134.  
  135.  
  136. DISCLAIMER:  Use this program at your own risk.
  137.